/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *   Free SoftwareFoundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package javax.resource.cci;

import javax.resource.ResourceException;

/**
 * Represents an application handle for the client.  The physical
 * connection is implemented by a ManagedConnection.
 */
public interface Connection {
  /**
   * Creates an Interaction for the Connection.  The Interaction is
   * like the JDBC Statement and actually does the work.
   */
  public Interaction createInteraction()
    throws ResourceException;

  /**
   * Returns a LocalTransaction instance to allow the resource manager
   * to manage local transactions.
   */
  public LocalTransaction getLocalTransaction()
    throws ResourceException;

  /**
   * Returns information on the underlying resource represented by
   * the connection.
   */
  public ConnectionMetaData getMetaData()
    throws ResourceException;

  /**
   * Returns metadata on the ResultSet capabitilities supported by the
   * connection.
   */
  public ResultSetInfo getResultSetInfo()
    throws ResourceException;

  /**
   * Closes the connection at the application level.
   */
  public void close()
    throws ResourceException;
}
